home *** CD-ROM | disk | FTP | other *** search
/ CU Amiga Super CD-ROM 21 / CU Amiga Magazine's Super CD-ROM 21 (1998)(EMAP Images)(GB)[!][issue 1998-04].iso / CUCD / Programming / MCC_MimeEditor / Developer / Autodocs / MCC_MimeEditor.doc
Text File  |  1998-01-27  |  7KB  |  204 lines
  1. TABLE OF CONTENTS
  2.  
  3. MimeEditor.mcc/MimeEditor.mcc
  4. MimeEditor.mcc/MUIA_MimeEditor_Changed
  5. MimeEditor.mcc/MUIA_MimeEditor_IconDrawer
  6. MimeEditor.mcc/MUIA_MimeEditor_Okay
  7. MimeEditor.mcc/MUIA_MimeEditor_Subject
  8. MimeEditor.mcc/MUIA_MimeEditor_To
  9. MimeEditor.mcc/MUIM_MimeEditor_InsertFile
  10. MimeEditor.mcc/MUIM_MimeEditor_InsertText
  11. MimeEditor.mcc/MUIM_MimeEditor_OpenFile
  12. MimeEditor.mcc/MUIM_MimeEditor_SaveFile
  13.  
  14. MimeEditor.mcc/MimeEditor.mcc
  15.  
  16.   MimeEditor.mcc is a class for dealing with MIME messages. It is a
  17.   subclass of group.mui.
  18.  
  19.   Note: When you want to start a new message, you will have to insert
  20.   a text part (with MUIM_MimeEditor_InsertText) yourself, this will not
  21.   be done automatically when creating a new MimeEditor.mcc object.
  22.  
  23.   The class is programmed by Ole Friis (ole_f@post3.tele.dk) and Leon
  24.   Woestenberg (leon@stack.nl).
  25.  
  26. MimeEditor.mcc/MUIA_MimeEditor_Changed
  27.  
  28.   NAME
  29.     MUIA_MimeEditor_Changed -- [.SG], BOOL
  30.  
  31.   FUNCTION
  32.     Indicates whether the user has made any modifications to the MIME
  33.     message or not. Use this tag to warn the user if he attempts to
  34.     cancel an edited message.
  35.  
  36.     NOTE: If you use MUIM_MimeEditor_Insert#? and MUIM_MimeEditor_OpenFile,
  37.     this attribute will become TRUE. As the most normal use of MimeEditor.mcc
  38.     is to first create the object, then inserting a blank text part, do remem-
  39.     ber to set this attribute to FALSE after having inserted the text part.
  40.     Also, you cannot take notify on this attribute.
  41.  
  42. MimeEditor.mcc/MUIA_MimeEditor_IconDrawer
  43.  
  44.   NAME
  45.     MUIA_MimeEditor_IconDrawer -- [I..], char *
  46.  
  47.   FUNCTION
  48.     Create-time attribute used to set the drawer in which the image files
  49.     for the toolbar icons are found. These files are ("_S" stands for
  50.     "selected", "_G" stands for "ghosted):
  51.  
  52.     Main toolbar icons: "MimeEditorStrip.buttons", "MimeEditor_S.buttons",
  53.     "MimeEditor_G.buttons".
  54.     The dummy ? sign: "PartButton.buttons", "PartButton_S.buttons",
  55.     "PartButton_G.buttons".
  56.     Text edit toolbar icons: "EditTextStrip.buttons",
  57.     "EditTextStrip_S.buttons", "EditTextStrip_G.buttons".
  58.  
  59.     If you can find some more sensible names, please let me know!
  60.     Please note: The "..._S.buttons" and "..._G.buttons" files are not
  61.     needed, just use them if you want a spiffier interface.
  62.     Note: If this tag is not specified, "PROGDIR:Buttons/" is used.
  63.  
  64. MimeEditor.mcc/MUIA_MimeEditor_Okay
  65.  
  66.   NAME
  67.     MUIA_MimeEditor_Okay -- [..G], ULONG
  68.  
  69.   FUNCTION
  70.     Tells you what parts of the MIME message are correct. Use this
  71.     attribute if you want to be sure that the message is OK before
  72.     letting the user save it to disk.
  73.  
  74.     The result is a ULONG. It must be interpreted this way ("result"
  75.     is the result you get):
  76.  
  77.     If ((result & MUIV_MimeEditor_Okay_Subject) != 0), it means that
  78.     the subject has been specified by the user.
  79.     If ((result & MUIV_MimeEditor_Okay_To) != 0), it means that the
  80.     "To:" field contains at least one recipient.
  81.     If ((result & MUIV_MimeEditor_Okay_Contents) != 0), it means that
  82.     the MIME message is not empty.
  83.  
  84.     Do not make any assumptions about the rest of the bits in the
  85.     result, because this attribute will be extended to using new bits
  86.     when new header fields etc. get implemented.
  87.  
  88. MimeEditor.mcc/MUIA_MimeEditor_Subject
  89.  
  90.   NAME
  91.     MUIA_MimeEditor_Subject -- [I..], char *
  92.  
  93.   FUNCTION
  94.     Text to put in the "Subject:" string gadget upon initialization.
  95.  
  96. MimeEditor.mcc/MUIA_MimeEditor_To
  97.  
  98.   NAME
  99.     MUIA_MimeEditor_To -- [I..], char *
  100.  
  101.   FUNCTION
  102.     Text to be put in the "To:" string gadget upon initialization.
  103.  
  104. MimeEditor.mcc/MUIM_MimeEditor_InsertFile
  105.  
  106.   NAME
  107.     MUIM_MimeEditor_InsertFile
  108.  
  109.   SYNOPSIS
  110.     DoMethod(obj,MUIM_MimeEditor_InsertFile,char *Filename);
  111.  
  112.   FUNCTION
  113.     Inserts the file Filename into the editor.
  114.  
  115.   RESULT
  116.     NONE
  117.  
  118. MimeEditor.mcc/MUIM_MimeEditor_InsertText
  119.  
  120.   NAME
  121.     MUIM_MimeEditor_InsertText
  122.  
  123.   SYNOPSIS
  124.     DoMethod(obj,MUIM_MimeEditor_InsertText,char *InitText);
  125.  
  126.   FUNCTION
  127.     Inserts a blank text part in the editor, containing only InitText
  128.     (or nothing if InitText is NULL).
  129.  
  130.   RESULT
  131.     NONE
  132.  
  133. MimeEditor.mcc/MUIM_MimeEditor_OpenFile
  134.  
  135.   NAME
  136.     MUIM_MimeEditor_OpenFile
  137.  
  138.   SYNOPSIS
  139.     DoMethod(obj,MUIM_MimeEditor_OpenFile,char *Filename,char *Citestring,
  140.              char *StartText,char *SignatureText);
  141.  
  142.   FUNCTION
  143.     Opens the file Filename. If CiteString is anything else than NULL, the
  144.     file will be loaded in the same manner as when you use "Reply" in your
  145.     mailer: Everything else than text parts is discarded, and the remaining
  146.     text parts get CiteString in front of every line.
  147.  
  148.     No matter what CiteString is, StartText is written at the start of every
  149.     text part. In CiteString the following control codes can be inserted:
  150.  
  151.     %n: Name of original author.
  152.     %i: Initials of original author's name.
  153.     %f: First name of original author.
  154.     %e: E-mail address of original author.
  155.     %d: Date (in "YAM format").
  156.     %s: Subject.
  157.  
  158.     More codes will probably be added in the future.
  159.  
  160.     If SignatureText is not NULL, this string will be inserted at the end of
  161.     every loaded text part. Please note: You have to insert "\n-- \n" at the
  162.     start of SignatureText yourself if you want the "signature part indicator"
  163.     known from most mail programs.
  164.  
  165.   RESULT
  166.     NONE (The editor field will contain an error message if the file could not
  167.     be opened or wasn't a MIME file)
  168.  
  169. MimeEditor.mcc/MUIM_MimeEditor_SaveFile
  170.  
  171.   NAME
  172.     MUIM_MimeEditor_SaveFile
  173.  
  174.   SYNOPSIS
  175.     DoMethod(obj,MUIM_MimeEditor_SaveFile,char *DestFile,char *FromAddress,
  176.              char **ExtraHeaders);
  177.  
  178.   FUNCTION
  179.     Saves the current contents of the editor to a file. The required parameters
  180.     are:
  181.  
  182.     DestFile - The destination file name. Please note: If you have previously
  183.       opened a file with MUIM_MimeEditor_Open, DestFile must *not* be the name
  184.       of the opened file. This is because, if some binary parts are in the
  185.       editor, it will just be copied directly from the original file, thus
  186.       saving resources.
  187.     FromAddress - The text to be put in the "From:" header field. *Must* be in
  188.       "normal e-mail format", which is:
  189.         ole_f@post3.tele.dk (Ole Friis)
  190.         ole_f@post3.tele.dk
  191.         Ole Friis <ole_f@post3.tele.dk>
  192.         "Friis, Ole" <ole_f@post3.tele.dk>
  193.       or similar) and *must* include an e-mail address. The FromAddress is
  194.       interpreted, and the e-mail address is used in the "Message-ID:" header
  195.       field.
  196.     ExtraHeaders - If you want to insert header lines at the main header part
  197.       of the saved message (e.g. "X-Mailer: Yo-Yo v. 4.3", this is the way to
  198.       do it. Simply give a NULL-terminated array of string pointers, and these
  199.       will be inserted at the top of the message. Don't worry if the strings
  200.       are too long, MimeEditor.mcc will take care of that.
  201.  
  202.   RESULT
  203.     NONE
  204.